8.5 查询应用列表

基本信息

Path：/api/v1/resource/queryAllResource

Method： GET

请求参数

Query

参数名称 是否必须 示例 备注
pageSize 非必须 20 每页数据数目 默认100
pageIndex 非必须 1 当前页 从1开始
filter 非必须 name 过滤条件，只能从 ['all', 'name', 'description', 'appAddress', 'accessAddress','creator', 'creatorRole']中选择。不传或者传空表示不添加过滤条件，即查询全部。
searchValue 非必须 test 搜索关键字，不传或者传空表示不添加过滤条件，即查询全部
sortBy 非必须 排序字段
asc 非必须 排序方式，1升序，0降序，默认升序
isPage 非必须 '0'不需要分页，'1' 需要分页

请求示例

pageSize=20&pageIndex=1filter=all&searchValue=test&pageSize=20&pageIndex=1

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 返回码，0代表成功
data object 必须 返回内容
├─ pageSize number 必须 页面条数
├─ pageIndex number 必须 页码
├─ count number 必须 应用数
├─ pageCount number 必须 总页数
├─ data object[] 必须 应用列表
├─ ├─ id string 必须 应用ID
├─ ├─ appAddress string 必须 应用地址，模式为 WEB,TP-WEB mock: https://1.2.3.1
├─ ├─ addressList object [] 非必须 应用地址列表,仅隧道应用
├─ ├─ ├─ protocol string 非必须 协议 tcp/udp/icmp/all
├─ ├─ ├─ host string 非必须 服务器地址
├─ ├─ ├─ port string 非必须 端口
├─ ├─ accessAddressConfig object [] 必须 前端地址别名, 仅 WEB item 类型: object
├─ ├─ ├─aliasList string [] 必须 别名列表 item 类型: string
├─ ├─ ├─actionList string [] 必须 需要进行的操作, 包括redirect(需要302跳转), listen（监听） item 类型: string
├─ ├─ accessModel string 必须 访问模式 WEB/L3VPN/TP-WEB mock: WEB
├─ ├─ aliasAppAddresses string 必须 应用地址别名，仅 WEB 模式
├─ ├─ accessAddress string 必须 访问地址 mock: https://12.3.4.5
├─ ├─ accessEntry string 必须 浏览器打开地址 mock: https://webapp.com/
├─ ├─ applyForInfo string 必须 用户申请信息
├─ ├─ description string 非必须 描述
├─ ├─ groupId string 必须 所属应用分类ID
├─ ├─ groupName string 必须 所属应用分类名称
├─ ├─ iconId string 必须 图标
├─ ├─ iconType string 必须 图标类型，只能属于['font', 'upload', 'capture']其一的值
├─ ├─ iconPath string 必须 图标路径名。如果类型为capture，则为抓取的url列表
├─ ├─ level string 必须 保密级别
├─ ├─ status number 必须 启用状态，0：禁用；1：启用 mock: 1
├─ ├─ baselineStatus number 必须 基线状态
├─ ├─ name string 必须 名字
├─ ├─ nodeGroupId string 必须 节点区域ID
├─ ├─ nodeGroupAddr object 必须 节点区域的访问地址
├─ ├─ ├─ lan string[] 必须 局域网访问地址
├─ ├─ ├─ wan string[] 必须 互联网访问地址
├─ ├─ trustedCertId string 必须 授信证书id，仅 WEB,TP-WEB 模式
├─ ├─ trustedCertName string 必须 授信证书名称，仅 WEB,TP-WEB 模式
├─ ├─ protocol string 必须 协议，l3vpn mock: HTTPS
├─ ├─ protocolType string 必须 协议类型
├─ ├─ ext object 非必须 扩展字段
├─ ├─ ├─ paths string [] 必须 URL路径规则 item 类型: string
├─ ├─ ├─ pathType number 必须 URL路径规则类型, 0 白名单, 1 黑名单
├─ ├─ ├─ pathStatus number 必须 URL路径规则启用状态, 0 禁用, 1 启用
├─ ├─ ├─ disableAccessAddressListen number 必须 0, 1
├─ ├─ ├─ reqRewriteAddress string 必须 自定义请求头部改写地址, web
├─ ├─ ├─ ipStatus number 必须 限制ip状态
├─ ├─ ├─ allowIps string [] 必须 限制ip item 类型: string
├─ ├─ ├─ dnsProxy object 必须 私有DNS解析
├─ ├─ ├─ ├─ enable number 必须 私有DNS解析启用状态
├─ ├─ ├─ ├─ enableLan number 必须 允许从局域网接入
├─ ├─ ├─ ├─ enableWan number 必须 允许从互联网接入
├─ ├─ ├─ dependSites object 必须 依赖站点配置
├─ ├─ ├─ ├─ enable number 必须 开关
├─ ├─ ├─ ├─ panDomain string 必须 泛域名
├─ ├─ ├─ ├─ siteList object [] 必须 依赖站点 item 类型: object
├─ ├─ ├─ ├─ ├─ appAddress string 必须 后端地址
├─ ├─ ├─ ├─ ├─ accessAddress string 必须 前端访问地址
├─ ├─ ├─ security object 必须 应用安全配置
├─ ├─ ├─ ├─ watermark object 必须 水印配置
├─ ├─ ├─ ├─ ├─ enable number 必须 开关
├─ ├─ ├─ ├─ netZone object 必须 接入IP限制(不建议使用openAPI操作)
├─ ├─ ├─ ├─├─ enable string 必须 0 表示关闭区域限制，1表示开启区域限制（限制为ids里面的区域）
├─ ├─ ├─ ├─ ├─ ids object [] 必须 关联的节点区域列表，每一个item是节点区域的详细信息 item 类型: object
├─ ├─ ssoConfig object 非必须 单点登录配置(不建议使用openAPI操作)
├─ ├─ ├─ enable boolean 非必须 true, false
├─ ├─ ├─ url string 非必须
├─ ├─ ├─ mode string 非必须
├─ ├─ ├─ intelligent object 非必须
├─ ├─ ├─ ├─ username object 非必须
├─ ├─ ├─ ├─ ├─ type string 非必须
├─ ├─ ├─ ├─ autoCommit boolean 非必须 true, false
├─ ├─ ├─ advanced object 非必须
├─ ├─ ├─ ├─ username object 非必须
├─ ├─ ├─ ├─ ├─ value object 非必须
├─ ├─ ├─ ├─ ├─ ├─ type string 非必须
├─ ├─ ├─ ├─ ├─ ├─ value string 非必须
├─ ├─ ├─ ├─ ├─ widgetType string 非必须
├─ ├─ ├─ ├─ ├─ match object 非必须
├─ ├─ ├─ ├─ ├─├─way string 非必须
├─ ├─ ├─ ├─ ├─ ├─value string 非必须
├─ ├─ ├─ ├─password object 非必须
├─ ├─ ├─ ├─ ├─value object 非必须
├─ ├─ ├─ ├─ ├─ ├─type string 非必须
├─ ├─ ├─ ├─ ├─ ├─value string 非必须
├─ ├─ ├─ ├─ ├─ widgetType string 非必须
├─ ├─ ├─ ├─ ├─ match object 非必须
├─ ├─ ├─ ├─ ├─├─ way string 非必须
├─ ├─ ├─ ├─ ├─ ├─ value string 非必须
├─ ├─ ├─ ├─ login object 非必须
├─ ├─ ├─ ├─ ├─ widgetType string 非必须
├─ ├─ ├─ ├─ ├─ match object 非必须
├─ ├─ ├─ ├─ ├─ ├─ way string 非必须
├─ ├─ ├─ ├─ ├─ ├─ value string 非必须
├─ ├─ ├─ ├─ userCustom1 object 非必须
├─ ├─ ├─ ├─ ├─ value object 非必须
├─ ├─ ├─ ├─ ├─ ├─ type string 非必须
├─ ├─ ├─ ├─ ├─ ├─ value string 非必须
├─ ├─ ├─ ├─ ├─ widgetType string 非必须
├─ ├─ ├─ ├─ ├─ match object 非必须
├─ ├─ ├─ ├─ ├─ ├─ way string 非必须
├─ ├─ ├─ ├─ ├─ ├─ value string 非必须
├─ ├─ ├─ ├─ userCustom2 object 非必须
├─ ├─ ├─ ├─ ├─├─ widgetType string 非必须
├─ ├─ ├─ ├─ ├─ match object 非必须
├─ ├─ ├─ ├─ ├─ ├─ way string 非必须
├─ ├─ ├─ ├─ ├─ ├─ value string 非必须
├─ ├─ ├─ ├─ autoCommit string 非必须 true, false
├─ ├─ ├─ oauth2 object 非必须 反向 OAuth2 模式配置
├─ ├─ ├─ ├─ appId string 非必须 反向 OAuth2 授权应用 ID
├─ ├─ ├─ ├─ appSecret string 非必须 反向 OAuth2 授权应用密钥
├─ ├─ ├─ ├─ enableReturnPassword number 非必须 是否开启返回密码
├─ ├─ ├─ ├─ mode string 非必须 反向 OAuth2 模式 proxy：票据注入；302： OAuth对接
├─ ├─ ├─ ├─ proxyUrl string 非必须 改写地址
├─ ├─ ├─ ├─ callbackUrl string 非必须 回调地址
├─ ├─ pathListLimit number 非必须 {} 是否启用url路径发布置
├─ ├─ webConf object 非必须 {} web应用相关配置
├─ ├─├─ passReqHost number 非必须 1 启用负载均衡时，往往需要将前端域名作为host头部传到上游，实现透明代理。
├─ ├─├─ loadBalance object 非必须 {} 负载均衡配置
├─ ├─├─├─ enable number 非必须 0 是否启用负载均衡
├─ ├─├─├─ protocol string 非必须 负载均衡的后端服务器地址协议，包括https或者http
├─ ├─├─├─ nodeList object[] 非必须 负载均衡多个后台服务器地址列表
├─ ├─├─├─├─ addr string 非必须 都在均衡模式下，后台服务器地址，注意不能填写协议头，如192.168.0.1:443
├─ ├─├─├─ type string 非必须 负载均衡算法，包含ip源地址hash，轮询，头部属性hash，cookie属性哈希，分别是ipHash,rr,headerHash,cookieHash，其中头部、cookie属性hash还需要配置key，指定一个hash的属性。
├─ ├─├─├─ key string 非必须 负载均衡算法选择头部属性、cookie属性hash时指定的hash属性。
├─ ├─├─├─ healthCheck object 非必须 负载均衡健康检查
├─ ├─├─├─├─ enable number 非必须 0 是否启用健康检查
├─ ├─├─├─├─ active object 非必须 主动健康检查配置
├─ ├─├─├─├─ type string 非必须 tcp 健康检查协议，支持tcp和http
├─ ├─├─├─├─ timeout number 非必须 10 健康检查超时时间，支持1-3600秒
├─ ├─├─├─├─ httpPath string 非必须 / 健康检查的http接口url，当type为http时生效且必填
├─ ├─├─├─├─ healthy object 非必须 健康节点相关配置
├─ ├─├─├─├─├─ interval number 非必须 10 健康节点的检查间隔，支持1-3600秒
├─ ├─├─├─├─├─ httpsStatuses number[] 非必须 [200,302] 健康节点返回的httpcode，当type为http时生效
├─ ├─├─├─├─├─ successes number 非必须 3 健康判定次数，支持1-50次
├─ ├─├─├─├─ unhealthy object 非必须 故障节点相关配置
├─ ├─├─├─├─├─ interval number 非必须 10 故障节点的检查间隔，支持1-3600秒
├─ ├─├─├─├─├─ failures number 非必须 3 故障判定次数，支持1-50次
├─ ├─├─ pathList object[] 非必须 url细粒度发布配置，可以发布域名下的指定路径。
├─ ├─├─├─ path string 非必须 路径支持"*"通配符在结尾，进行模糊匹配；不带"*"时是精确匹配模式。
├─ ├─├─├─ desc string 非必须 发布路径的备注，建议填写发布路径的初衷，方便后续维护
├─ ├─├─excludePathStatus number 非必须 0 是否启用url发布排除路径，启用后可以在发布路径中排除部分路径
├─ ├─├─excludePathList object[] 非必须 url发布排除路径列表
├─ ├─├─├─ path string 非必须 路径支持"*"通配符在结尾，进行模糊匹配；不带"*"时是精确匹配模式。需要保证排除路径是已经发布的pathList中路径的字路径。
├─ ├─├─├─ desc string 非必须 排除路径的备注，建议填写排除路径的初衷，方便后续维护
msg string 必须 描述信息  

返回示例

{
    "code": 0,
    "data": {
        "pageSize": 20,
        "pageIndex": 1,
        "count": 2,
        "pageCount": 1,
        "data": [{
            "id": "c4f643f0-5717-11eb-b6e0-f7651d8dccc0",
            "status": 1,
            "accessModel": "L3VPN",
            "name": "zcl_env",
            "description": "",
            "groupId": "default",
            "appAddress": "",
            "accessAddress": "",
            "trustedCertId": "",
            "protocol": "",
            "nodeGroupId": "162a5d3c-2266-4643-9c50-c5e619fa7e6e",
            "iconId": "1",
            "level": "3",
            "ext": "{\"paths\":[],\"readXFF\":0,\"allowIps\":[],\"dnsProxy\":{\"enable\":0,\"enableLan\":0,\"enableWan\":0},\"ipStatus\":0,\"pathType\":1,\"security\":{\"netZone\":{\"enable\":0},\"watermark\":{\"enable\":0}},\"pathStatus\":0,\"addressList\":[{\"host\":\"192.168.1.0/24\",\"port\":\"6440,4433,22\"}],\"dependSites\":{\"enable\":0,\"panDomain\":\"\",\"isPanDomainCert\":false},\"enableTransparentProxy\":0,\"disableAccessAddressListen\":0,\"openModel\":{\"model\":\"default-browser\",\"issuerName\":[],\"processName\":\"\",\"programName\":\"\",\"originalFilename\":\"\",\"useDefaultBrowser\":0,\"programDownloadUrl\":\"\"}}",
            "addressList": [{
                "host": "192.168.1.0/24",
                "port": "6440,4433,22"
            }],
            "iconPath": "",
            "iconType": "font",
            "creator": "sdpc",
            "creatorRole": "超级管理员",
            "baselineStatus": 0,
            "applyForInfo": "[object Object]"
        }, {
            "id": "0e8cec60-5585-11eb-9aa3-27b058cac48b",
            "status": 1,
            "accessModel": "L3VPN",
            "name": "sdp控制台",
            "description": "",
            "groupId": "default",
            "appAddress": "",
            "accessAddress": "https://192.168.1.2:4433",
            "trustedCertId": "",
            "protocol": "",
            "nodeGroupId": "162a5d3c-2266-4643-9c50-c5e619fa7e6e",
            "iconId": "1",
            "level": "3",
            "ext": "{\"paths\":[],\"readXFF\":0,\"allowIps\":[],\"dnsProxy\":{\"enable\":0,\"enableLan\":0,\"enableWan\":0},\"ipStatus\":0,\"pathType\":1,\"security\":{\"netZone\":{\"ids\":[],\"enable\":0},\"watermark\":{\"enable\":0}},\"pathStatus\":0,\"addressList\":[{\"host\":\"192.168.1.2\",\"port\":\"4433,22\"}],\"dependSites\":{\"enable\":0,\"panDomain\":\"\",\"isPanDomainCert\":false},\"enableTransparentProxy\":0,\"disableAccessAddressListen\":0,\"openModel\":{\"model\":\"default-browser\",\"issuerName\":[],\"processName\":\"\",\"programName\":\"\",\"originalFilename\":\"\",\"useDefaultBrowser\":0,\"programDownloadUrl\":\"\"}}",
            "addressList": [{
                "host": "192.168.1.2",
                "port": "4433,22"
            }],
            "iconPath": "",
            "iconType": "font",
            "creator": "sdpc",
            "creatorRole": "超级管理员",
            "baselineStatus": 0,
            "applyForInfo": "[object Object]"
        }]
    },
    "msg": "请求成功"
}

错误信息

错误提示 错误码
参数检查出错 10000001
深信服科技 all right reserved，powered by Gitbook本文档更新于： 2024-05-18 14:38

results matching ""

    No results matching ""